/**
 * (C) Copyright IBM Corp. 2019, 2020.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/

import Foundation

/**
 Display settings for aggregations.
 */
public struct ComponentSettingsAggregation: Codable, Equatable {

    /**
     Type of visualization to use when rendering the aggregation.
     */
    public enum VisualizationType: String {
        case auto = "auto"
        case facetTable = "facet_table"
        case wordCloud = "word_cloud"
        case map = "map"
    }

    /**
     Identifier used to map aggregation settings to aggregation configuration.
     */
    public var name: String?

    /**
     User-friendly alias for the aggregation.
     */
    public var label: String?

    /**
     Whether users is allowed to select more than one of the aggregation terms.
     */
    public var multipleSelectionsAllowed: Bool?

    /**
     Type of visualization to use when rendering the aggregation.
     */
    public var visualizationType: String?

    // Map each property name to the key that shall be used for encoding/decoding.
    private enum CodingKeys: String, CodingKey {
        case name = "name"
        case label = "label"
        case multipleSelectionsAllowed = "multiple_selections_allowed"
        case visualizationType = "visualization_type"
    }

}
